Documenter manual and docs deployment for 1.0 - #109
Open
tanmaykm wants to merge 4 commits into
Open
Conversation
ClientPlan, ServerPlan, NormalizedAPI, DocumentVersion, location, oas_family, obj, and parse were the only public names without docstrings; the Documenter reference page checks public coverage.
Home, migration (mirrored from MIGRATION.md at build time so the two cannot drift), nine manual pages reorganized from the README, and an API reference covering every public name (checkdocs = :public). The pipeline, server, and authoring pages run their examples at build time against inline documents, so the site fails to build if the documented behavior drifts from the code.
Same julia-docdeploy flow the 0.2 lane uses; deploydocs targets devbranch main, deploys versioned docs on tags, and pushes PR previews.
The full content now lives in the Documenter manual, in one place; the README keeps the overview, quick starts, and migration pointer, and gains docs and CI badges.
4 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Restores documentation generation for the 1.0 line — the docs site item from #104. PR #103 removed the 0.2 Documenter setup along with everything else; since then nothing updates the site, whose state is worse than stale:
gh-pageshas no v0.2.x versioned docs at all (tag-triggered deploys silently stopped after v0.1.23), sostablestill serves v0.1.23.What this adds
A full Documenter manual (
docs/): a home page, the migration guide (mirrored from the rootMIGRATION.mdat build time so the two cannot drift), nine manual pages reorganized from the README — clients, streaming/codecs, security, servers, document authoring, pipeline/diagnostics, generated models, the generated-code contract, and the support boundary — and an API reference covering every public name (checkdocs = :publicenforces that coverage at build time).The pipeline, server, and authoring pages run their examples at build time (
@exampleblocks) against inline documents: the server page renders the actual generated handler-signature header, the pipeline page runs load → check → normalize → plan → emit end to end, and the authoring page prints the full generated OpenAPI document. If documented behavior drifts from the code, the docs build fails.Docstrings for the eight public names that lacked them (
ClientPlan,ServerPlan,NormalizedAPI,DocumentVersion,location,oas_family,obj,parse) — required by the coverage check, useful regardless.A CI docs job using the same
julia-docdeployflow as the 0.2 lane:deploydocstargetsdevbranch = "main", deploys versioned docs on tags, and pushes PR previews.A trimmed README: the full content now lives in the manual in one place; the README keeps the overview, quick starts, and migration pointer, and gains docs/CI badges. (Separable commit if you'd rather keep the long README.)
What happens to the site
devdocs start tracking main again (currently frozen at v0.2.8 content).v1.0.0docs deploy andstablefinally moves off v0.1.23.release-0.2(after fix(client): keep form-style CSV separators literal in query strings #107) will exercise that branch's own docs job and backfill 0.2 versioned docs — provided theDOCUMENTER_KEYsecret is still valid, which the silent tag-deploy failures since v0.1.23 make worth checking. This PR's Documentation check on CI will confirm the build; the deploy path is only exercised on push.Validation
Built locally from a clean docs environment: zero Documenter warnings (cross-references, docstring coverage, and example execution all clean). Local build:
julia --project=docs -e 'using Pkg; Pkg.develop(path="."); Pkg.instantiate()' julia --project=docs docs/make.jlPart of #104.